/***********************************************************************************************************************
*                                                                                                                      *
* libscopeprotocols                                                                                                    *
*                                                                                                                      *
* Copyright (c) 2012-2025 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/

/**
	@file
	@author Andrew D. Zonenberg
	@brief Declaration of ACRMSMeasurement
 */
#ifndef ACRMSMeasurement_h
#define ACRMSMeasurement_h

#include "../scopehal/Averager.h"
#include "../scopehal/LevelCrossingDetector.h"

struct __attribute__((packed)) ACRMSPushConstants
{
	uint32_t numSamples;
	uint32_t numThreads;
	uint32_t samplesPerThread;
	float dcBias;
};

struct __attribute__((packed)) ACRMSTrendPushConstants
{
	int64_t timescale;
	int64_t numSamples;
	uint32_t numEdgePairs;
	float dcBias;
};

class ACRMSMeasurement : public Filter
{
public:
	ACRMSMeasurement(const std::string& color);

	virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;

	static std::string GetProtocolName();

	virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
	virtual DataLocation GetInputLocation() override;

protected:
	void DoRefreshSparse(SparseAnalogWaveform* wfm);
	void DoRefreshUniform(
		UniformAnalogWaveform* wfm,
		vk::raii::CommandBuffer& cmdBuf,
		std::shared_ptr<QueueHandle> queue);

	Averager m_averager;
	LevelCrossingDetector m_detector;

	std::unique_ptr<ComputePipeline> m_rmsComputePipeline;
	AcceleratorBuffer<float> m_temporaryResults;

	std::unique_ptr<ComputePipeline> m_trendComputePipeline;

public:
	PROTOCOL_DECODER_INITPROC(ACRMSMeasurement)
};

#endif
